gatlingのレスポンスボディをCirceでデコードする

佐々木一洋

2019.06.18

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

はじめに

GatlingでAPIテストを記述しているとリクエストボディのJSONに対するアサーションを記述する場合があります。公式にはJSON PathでJSONの中身を取り出すAPIが提供されています。

Gatling Checks

こんな感じです。

// JSON Response
{
  "foo": 1,
  "bar" "baz"
}

jsonPath("$..foo").ofType[Int] // will match 1

Circeでパースしたい

Scalaを使っているとCirceでVOにマッピングしたくなるのが人情です。やってみます。

こうなる

そして、いきなりですが、こうなります。(コード全体はこちらにあります)

object CirceOps {

  type ParseResult[A] = Either[Throwable, A]
  type RequestBodyType = Option[String]

  //Either[Throwable, A] => Validation[A]の変換
  private val parseResultToValidation = new FunctionK[ParseResult, Validation] {
    override def apply[A](fa: ParseResult[A]): Validation[A] = fa.fold(l => Failure(l.getMessage), r => Success(r))
  }

  //パース(Option[String] => Either[Throwable, Option[A]])
  private def parse[A: Decoder]: Kleisli[ParseResult, RequestBodyType, Option[A]] = Kleisli[ParseResult, RequestBodyType, Option[A]] { (a: RequestBodyType) =>
    a match {
      case Some(s) => parseJson(s).flatMap(_.as[A].map(_.some))
      case None => none[A].asRight
    }
  }


  /**
    * リクエストボディをAとしてパースする
    * @param bodyString
    * @tparam A
    * @return
    */
  def parseRequestBody[A: Decoder](bodyString: RequestBodyType): Validation[Option[A]] = parse.mapK(parseResultToValidation).run(bodyString)


}

使い方

JSONは以下のようなcase classにマッピングされるとします。

final case class Greeting(greeting: String) extends AnyVal

object Greeting {
    implicit val greetingEncoder: Encoder[Greeting] = (a: Greeting) => Json.obj(
          ("message", Json.fromString(a.greeting)),
        )
    implicit val greetingDecoder: Decoder[Greeting] = (c: HCursor) => c.downField("message").as[String].map(Greeting.apply)
}

こんな感じでbodyString.transformOptionの引数で渡す関数としてCirceOps#parseRequestBodyを指定します。

val sc = scenario("Hello").exec(
    http("GET /hello/myName")
      .get("/hello/myName")
      //パースしてGreetingのインスタンスと比較
      .check(
        bodyString.transformOption(parseRequestBody[Greeting](_)).is((Greeting("Hello, myName")))
      )
  )